home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / tag_bbs / fpoints3.zip / FPOINTS.DOC < prev    next >
Text File  |  1992-07-23  |  14KB  |  333 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.                              FPOINTS Version 3.0
  14.                              ===================
  15.                              Copyright (c) 1992
  16.                              By Dragon Software
  17.                                  23 Jul 92
  18.                              ALL RIGHTS RESERVED
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60. FPOINTS Version 3.0 by Dragon Software                                  Page 1
  61. ==============================================================================
  62.  
  63. DISCLAIMER:
  64. ===========
  65. This program is provided "As Is".  All responsibility and risk in running
  66. this program is taken on completely by the person using this program.  This
  67. program comes without any warranty, expressed or implied.  If you do not
  68. agree with the above, please don't use this program.
  69.  
  70.  
  71. FPOINTS INTRODUCTION:
  72. =====================
  73. This program will automatically update the "Point Value Field" of the *.DIR
  74. file and "Point Value Field" of the USER.LST file using Point Values specified
  75. by you in a config file for all files uploaded to T.A.G. v2.6c1.  File Points
  76. can be assigned by one of three methods: A GLOBAL value for all files uploaded;
  77. by the file upload PATH; or by the file SIZE (in kbytes).  A different Point
  78. Value can also be specified for both the File and the User.  Information
  79. is displayed on the local and remote end letting the SysOp and User know what
  80. is going on.  You may use FPCONFIG.EXE to create the configuration file
  81. (FPOINTS.CFG) or any Text Editor that saves the file in ASCII text format.  The
  82. FPOINTS.CFG file must reside in the same directory as FPOINTS.EXE.
  83.  
  84.  
  85. USAGE:
  86. ======
  87. FPOINTS %2 %3 %4 %5 %6
  88.  
  89.  
  90. FPOINTS COMMAND LINE PARAMETERS:
  91. ================================
  92. The information for these parameters is passed to the "POSTUL.BAT" file by
  93. T.A.G. itself.  Here is a brief description of what they stand for:
  94.  
  95. %2:    Comport 1-4.
  96. %3:    User ID#.
  97. %4:    Upload path where file went.
  98. %5:    Filename of uploaded file.
  99. %6:    Filename of *.DIR file.
  100.  
  101.  
  102. EXAMPLE "POSTUL.BAT" FILE:
  103. ==========================
  104. ECHO OFF                 <---- Turn echoing of commands off (Optional).
  105. CLS                      <---- Clear the screen (Optional).
  106. FPOINTS %2 %3 %4 %5 %6   <---- Program to run and parameters (Mandatory).
  107.  
  108. The "POSTUL.BAT" file must be placed in the "MAIN BBS DIR" (normally C:\BBS).
  109. FPOINTS searches for the uploaded file and will not credit the user if that
  110. file is not found.  Because of the deletion feature of TAGSCAN, FPOINTS should
  111. be called after TAGSCAN if your POSTUL.BAT file calls TAGSCAN.  FPOINTS can be
  112. run from the "MAIN BBS DIR" or it's own directory (make sure the "POSTUL.BAT
  113. file reflects this).
  114.  
  115. TAGSCAN is the post upload Virus Scan utility, copywrited by Tony Mann and
  116. Bill VanWeezenbeeck.
  117.  
  118.  
  119. FPOINTS Version 3.0 by Dragon Software                                  Page 2
  120. ==============================================================================
  121.  
  122. EXAMPLE "FPOINTS.CFG" FILE FOR "GLOBAL" FILE POINT ASSIGNMENT:
  123. ==============================================================
  124. C:\BBS\DFILES           <---- Your "Main Data File Path".
  125. C:\MULTI                <---- Your "Multi-user Data File Path".
  126. C:\BBS\FPOINTS.LOG      <---- Path and File Name for the LOG.
  127. 1F/5U                   <---- File Points (0-255)/User Points (0-65535) to
  128.                               assign to all uploaded Files/Users.  Please
  129.                               insure that the "F", "/" and "U" are placed as
  130.                               shown.
  131.  
  132. Note: Only four lines are required for this setup!
  133.  
  134. An error will result if any of these lines are incorrect.  Although spaces are
  135. checked for by FPOINTS, it is recommended that none be placed before, within
  136. or after any line in the FPOINTS.CFG file.
  137.  
  138.  
  139. EXAMPLE "FPOINTS.CFG" FILE FOR "PATH" FILE POINT ASSIGNMENT:
  140. ============================================================
  141. C:\BBS\DFILES               <---- Your "Main Data File Path".
  142. C:\MULTI                    <---- Your "Multi-user Data File Path".
  143. C:\BBS\FPOINTS.LOG          <---- Path and File Name for the LOG.
  144. 1F/5U                       <---- File Points (0-255)F/User Points (0-65535)U
  145.                                   to assign to all uploaded files that are not
  146.                                   found within the Paths specified within the
  147.                                   following lines.  Please insure that the "F",
  148.                                   "/" and "U" are placed as shown.
  149. PATH                        <---- Statement required if you are assigning File
  150.                                   Points by Upload Path.
  151. C:\BBS\FILES\SYSOP\/5F/10U  <---- Complete path (with trailing Back-Slash)/File
  152.                                   Points (0-255)F/User Points (0-65535)U.
  153.                                   Please insure that the "F", "/"'s and "U" are
  154.                                   placed as shown.
  155. C:\BBS\FILES\LEE\/0F/20U    <---- Complete path (with trailing Back-Slash)/File
  156.                                   Points (0-255)F/User Points (0-65535)U.
  157.                                   Please insure that the "F", "/"'s and "U" are
  158.                                   placed as shown.
  159.  
  160. Note: The above example would only be seven lines long in the actual
  161.       FPOINTS.CFG file.  There is no limit to the number of "Upload
  162.       Paths" that may be specified.
  163.  
  164. An error will result if any of the first five lines are incorrect.  Although
  165. spaces are checked for by FPOINTS, it is recommended that none be placed
  166. before, within or after any line in the FPOINTS.CFG file.  In the above
  167. example, all files uploaded to "C:\BBS\FILES\SYSOP\" would be credited with "5"
  168. File Points and the User with "10" File Points.  If a File were to be uploaded
  169. to "C:\BBS\FILES\TEMP\" (Which is not defined above), the File would be
  170. credited with "1" File Point and the User with "5" File Points (the default on
  171. Line 2).  Any files uploaded to "C:\BBS\FILES\LEE\" would be given no credit,
  172. but the User would receive "20" File Points.  The main thing you should know is
  173. this:  If you don't setup the Upload Paths or the File/User Point Values
  174. correctly, the File Points on Line 4 will be used an no errors will result!
  175.  
  176. "ALLPNT" and "DIRPNT" can be used to convert your existing File Base.
  177.  
  178. FPOINTS Version 3.0 by Dragon Software                                  Page 3
  179. ==============================================================================
  180.  
  181. EXAMPLE "FPOINTS.CFG" FILE FOR "SIZE (KBYTES)" FILE POINT ASSIGNMENT:
  182. =====================================================================
  183. C:\BBS\DFILES               <---- Your "Main Data File Path".
  184. C:\MULTI                    <---- Your "Multi-user Data File Path".
  185. C:\BBS\FPOINTS.LOG          <---- Path and File Name for the LOG.
  186. 1F/5U                       <---- File Points (0-255)F/User Points (0-65535)U
  187.                                   to assign to all uploaded files that are not
  188.                                   found within the Paths specified within the
  189.                                   following lines.  Please insure that the "F",
  190.                                   "/" and "U" are placed as shown.
  191. SIZE                        <---- Statement required if you are assigning File
  192.                                   Points by File Size (Kbytes).
  193. 1-5K/5F/10U                 <---- Minimum Kbytes (1-5000)-Maximum Kbytes
  194.                                   (1-5000)K/File Points (0-255)F/User Points
  195.                                   (0-65535)U.  Please insure that the "K", "F",
  196.                                   "/"'s and "U" are placed as shown.
  197. 6-10K/0F/20U                <---- Minimum Kbytes (1-5000)-Maximum Kbytes
  198.                                   (1-5000)K/File Points (0-255)F/User Points
  199.                                   (0-65535)U.  Please insure that the "K", "F",
  200.                                   "/"'s and "U" are placed as shown.
  201.  
  202. Note: The above example would only be seven lines long in the actual
  203.       FPOINTS.CFG file.  The only limit to the number of lines beyond
  204.       Line 5 of FPOINTS.CFG is the Kbytes Maximum range of 5000 (which
  205.       allows for a 5,120,000 Byte file).  File sizes are rounded to the
  206.       next highest value evenly divisable by 1024 Bytes, therefore a
  207.       value less then 1 Kbyte will never occur.
  208.  
  209. An error will result if any of the first five lines are incorrect.   Although
  210. spaces are checked for by FPOINTS, it is recommended that none be placed
  211. before, within or after any line in the FPOINTS.CFG file.  In the above
  212. example, a file uploaded that is 1-Kbyte, would fall within the range 1-5
  213. Kbytes and would be credited with "5" File Points and the User with "10" File
  214. Points.  If a file were uploaded that is 15-KBytes, (Which is not defined
  215. above), the File would be credited with "1" File Point and the User with "5"
  216. File Points (the default on Line 2).  A file that is 9-Kbytes, would fall
  217. within the range 6-10 Kbytes and the File would be given no credit, but the
  218. User would receive "20" File Points.  The main thing you should know is this:
  219. If you don't setup the Kbytes ranges or the File/User Point Values correctly,
  220. the File Points on Line 4 will be used an no errors will result!
  221.  
  222. "KBYTECVT" can be used to convert your existing File Base.
  223.  
  224.  
  225. MISCELANEOUS INFORMATION:
  226. =========================
  227. When crediting the user with File Points, FPOINTS will not exceed the limit
  228. of the "File Points Field" in the User Record (Limit is 65,535). Additionally,
  229. FPOINTS will not exceed the limit of the "File Points Field" in the *.DIR
  230. file (Limit is 255).  FPOINTS has a number of "Error Messages" that are all
  231. self-explanatory.
  232.  
  233.  
  234.  
  235.  
  236.  
  237. FPOINTS Version 3.0 by Dragon Software                                  Page 4
  238. ==============================================================================
  239.  
  240. UPDATE HISTORY:
  241. ===============
  242.                                 Version 1.0
  243.                                 ===========
  244.  
  245. -   Released on 02 May 92 for T.A.G. Version 2.6.
  246.  
  247.                                 Version 2.0
  248.                                 ===========
  249.  
  250. -   Released on 13 Jun 92 for T.A.G. Version 2.6c1.
  251.  
  252. -   Removed the Clear Screen within FPOINTS.EXE so that the SysOp window is
  253.     not effected.
  254.  
  255. -   FPOINTS.EXE will no longer write a file (COM0) to the drive when T.A.G. is
  256.     in LOCAL MODE.
  257.  
  258. -   Added the ability for FPOINTS.EXE to recognize the "@" in front of the *.DIR
  259.     file name in the FBOARDS.DAT file (used to send *.DIR files to the Data
  260.     Files Directory) and the "`" in front of the *.DIR file name in the
  261.     FBOARDS.DAT file (used to send *.DIR files to the Multi-Node Path).
  262.  
  263. -   Increased the allowable Point Value for the User Record from 32,767 to
  264.     65,535.
  265.  
  266. -   Added the ability for FPOINTS.EXE to credit the File uploaded and User with
  267.     different Points.
  268.  
  269. -   Added the ability for the SysOp to assign File Points by one of three
  270.     methods:  Globally for all files uploaded, by file size (kbytes) or by
  271.     file upload path.
  272.  
  273. -   Added a configuration editor (FPCONFIG.EXE) to create the three different
  274.     FPOINTS.CFG files.
  275.  
  276. -   Fixed the problem with FPOINTS not finding "Batch Uploaded" files (Missed
  277.     this note in the 2.0 Release).
  278.  
  279.                                 Version 3.0
  280.                                 ===========
  281.  
  282. -   Released on 23 Jul 92 for T.A.G. Version 2.6c1.
  283.  
  284. -   Fixed a bug that was created when we added the ability for SysOps to use
  285.     one of three methods when assigning File Points.  This bug prevented
  286.     checking to verify files were actually present in the Upload Directory
  287.     before assigning File Points in the "GLOBAL" mode of operation.  The
  288.     "PATH" and "SIZE" modes were not effected by this bug!
  289.  
  290. -   Added a log feature.
  291.  
  292. -   Added a SIZE (Kbyte) Conversion Utility (KBYTECVT.EXE) that will convert
  293.     your entire File Base over to the Point Values you assign in the
  294.     FPOINTS.CFG file.
  295.  
  296. FPOINTS Version 3.0 by Dragon Software                                  Page 5
  297. ==============================================================================
  298.  
  299. FUTURE UPDATES:
  300. ===============
  301. Make FPOINTS "Share" and "Multi-node" aware.  Possibly come up with a better
  302. way to convert the file base over when using the "PATH" option, instead of
  303. using DIRPNT the way it is currently designed.
  304.  
  305.  
  306. THANKS:
  307. =======
  308. A special "THANKS" goes to the T.A.G. Team for all the work they have done on
  309. T.A.G. and for the T.A.G. v2.6b Turbo Pascal Record Structures!  Thanks also
  310. goes to Wade Fallin, SysOp of Whispers BBS for his suggestion to write the
  311. FPOINTS utility.
  312.  
  313.  
  314. COMMENTS:
  315. =========
  316. If you have any suggestions or comments for this program, please
  317. leave a message addressed to "NUCLEAR" or "MERCURY" on one of the
  318. following BBS's:
  319.  
  320. Fantasy Island              (804)486-0724        Fidonet 1:275/4
  321. Whispers BBS (T.A.G. BETA)  (904)744-5624        Fidonet 1:112/90
  322. The Gathering               (804)481-3090
  323.  
  324. Or send a letter to (In care of: Dragon Software):
  325.  
  326. Lee Palmer                         Rick Mercado
  327. 1660 Kepler Bend                   8216 Edwin Drive
  328. Virginia Beach, VA. 23454          Norfolk, Va. 23505
  329. (804)426-7048                      (804)588-7125
  330.  
  331. Or call Dragon Software BBS at (804)480-3909 Fidonet 1:275/78
  332.  
  333.